<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Invalidate API key API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'security-api-invalidate-api-key.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/security-api-invalidate-api-key.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/security-api-invalidate-api-key.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/security-api-invalidate-api-key.html" rel="nofollow" target="_blank">../en/security-api-invalidate-api-key.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="security-api.html">Security APIs</a></span>
»
<span class="breadcrumb-node">Invalidate API key API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="security-api-has-privileges.html">« Has privileges API</a>
</span>
<span class="next">
<a href="security-api-invalidate-token.html">Invalidate token API »</a>
</span>
</div>
<div class="section xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="security-api-invalidate-api-key"></a>Invalidate API key API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc">edit</a><a class="xpack_tag" href="https://www.elastic.co/subscriptions"></a>
</h2>
</div></div></div>

<p>Invalidates one or more API keys.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="security-api-invalidate-api-key-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">DELETE /_security/api_key</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="security-api-invalidate-api-key-prereqs"></a>Prerequisites<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
To use this API, you must have at least the <code class="literal">manage_api_key</code> cluster privilege.
</li>
</ul>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="security-api-invalidate-api-key-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc">edit</a>
</h3>
</div></div></div>
<p>The API keys created by <a class="xref" href="security-api-create-api-key.html" title="Create API key API">create API Key</a> can be
invalidated using this API.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="security-api-invalidate-api-key-request-body"></a>Request body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc">edit</a>
</h3>
</div></div></div>
<p>The following parameters can be specified in the body of a DELETE request and
pertain to invalidating api keys:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">id</code>
</span>
</dt>
<dd>
(Optional, string) An API key id. This parameter cannot be used with any of
<code class="literal">name</code>, <code class="literal">realm_name</code> or <code class="literal">username</code> are used.
</dd>
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(Optional, string) An API key name. This parameter cannot be used with any of
<code class="literal">id</code>, <code class="literal">realm_name</code> or <code class="literal">username</code> are used.
</dd>
<dt>
<span class="term">
<code class="literal">realm_name</code>
</span>
</dt>
<dd>
(Optional, string) The name of an authentication realm. This parameter cannot be
used with either <code class="literal">id</code> or <code class="literal">name</code> or when <code class="literal">owner</code> flag is set to <code class="literal">true</code>.
</dd>
<dt>
<span class="term">
<code class="literal">username</code>
</span>
</dt>
<dd>
(Optional, string) The username of a user. This parameter cannot be used with
either <code class="literal">id</code> or <code class="literal">name</code> or when <code class="literal">owner</code> flag is set to <code class="literal">true</code>.
</dd>
<dt>
<span class="term">
<code class="literal">owner</code>
</span>
</dt>
<dd>
(Optional, boolean) A boolean flag that can be used to query API keys owned
by the currently authenticated user. Defaults to false.
The <em>realm_name</em> or <em>username</em> parameters cannot be specified when this
parameter is set to <em>true</em> as they are assumed to be the currently authenticated ones.
</dd>
</dl>
</div>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>At least one of "id", "name", "username" and "realm_name" must be specified
 if "owner" is "false" (default).</p>
</div>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="security-api-invalidate-api-key-response-body"></a>Response body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc">edit</a>
</h3>
</div></div></div>
<p>A successful call returns a JSON structure that contains the ids of the API keys
that were invalidated, the ids of the API keys that had already been invalidated,
and potentially a list of errors encountered while invalidating specific api
keys.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="security-api-invalidate-api-key-example"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc">edit</a>
</h3>
</div></div></div>
<p>If you create an API key as follows:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST /_security/api_key
{
  "name": "my-api-key"
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2109.console"></div>
<p>A successful call returns a JSON structure that provides
API key information. For example:</p>
<div class="pre_wrapper lang-console-result">
<pre class="programlisting prettyprint lang-console-result">{
  "id":"VuaCfGcBCdbkQm-e5aOx",
  "name":"my-api-key",
  "api_key":"ui2lp2axTNmsyakw9tvNnw"
}</pre>
</div>
<p>The following example invalidates the API key identified by specified <code class="literal">id</code>
immediately:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">DELETE /_security/api_key
{
  "id" : "VuaCfGcBCdbkQm-e5aOx"
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2110.console"></div>
<p>The following example invalidates the API key identified by specified <code class="literal">name</code>
immediately:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">DELETE /_security/api_key
{
  "name" : "my-api-key"
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2111.console"></div>
<p>The following example invalidates all API keys for the <code class="literal">native1</code> realm
immediately:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">DELETE /_security/api_key
{
  "realm_name" : "native1"
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2112.console"></div>
<p>The following example invalidates all API keys for the user <code class="literal">myuser</code> in all
realms immediately:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">DELETE /_security/api_key
{
  "username" : "myuser"
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2113.console"></div>
<p>The following example invalidates the API key identified by the specified <code class="literal">id</code> if
 it is owned by the currently authenticated user immediately:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">DELETE /_security/api_key
{
  "id" : "VuaCfGcBCdbkQm-e5aOx",
  "owner" : "true"
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2114.console"></div>
<p>The following example invalidates all API keys owned by the currently authenticated
 user immediately:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">DELETE /_security/api_key
{
  "owner" : "true"
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2115.console"></div>
<p>Finally, the following example invalidates all API keys for the user <code class="literal">myuser</code> in
 the <code class="literal">native1</code> realm immediately:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">DELETE /_security/api_key
{
  "username" : "myuser",
  "realm_name" : "native1"
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2116.console"></div>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">{
  "invalidated_api_keys": [ <a id="CO660-1"></a><i class="conum" data-value="1"></i>
    "api-key-id-1"
  ],
  "previously_invalidated_api_keys": [ <a id="CO660-2"></a><i class="conum" data-value="2"></i>
    "api-key-id-2",
    "api-key-id-3"
  ],
  "error_count": 2, <a id="CO660-3"></a><i class="conum" data-value="3"></i>
  "error_details": [ <a id="CO660-4"></a><i class="conum" data-value="4"></i>
    {
      "type": "exception",
      "reason": "error occurred while invalidating api keys",
      "caused_by": {
        "type": "illegal_argument_exception",
        "reason": "invalid api key id"
      }
    },
    {
      "type": "exception",
      "reason": "error occurred while invalidating api keys",
      "caused_by": {
        "type": "illegal_argument_exception",
        "reason": "invalid api key id"
      }
    }
  ]
}</pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO660-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>The IDs of the API keys that were invalidated as part of this request.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO660-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>The IDs of the API keys that were already invalidated.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO660-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>The number of errors that were encountered when invalidating the API keys.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO660-4"><i class="conum" data-value="4"></i></a></p>
</td>
<td align="left" valign="top">
<p>Details about these errors. This field is not present in the response when
<code class="literal">error_count</code> is 0.</p>
</td>
</tr>
</table>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="security-api-has-privileges.html">« Has privileges API</a>
</span>
<span class="next">
<a href="security-api-invalidate-token.html">Invalidate token API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>